<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>

<title>org.gradle.api (Gradle API 2.0)</title>
<meta name="keywords" content="org.gradle.api package">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" title="Style">
<link href="../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../../groovy.ico" type="image/x-icon" rel="icon">
<script type="text/javascript">
function windowTitle()
{
    parent.document.title="org.gradle.api (Gradle API 2.0)";
}
</script>
<noscript>
</noscript>

</head>

<body class="center" onload="windowTitle();">

<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
<a name="navbar_top_firstrow"><!-- --></a>
<ul class="navList" title="Navigation">
    <li><a href="../../../overview-summary.html">Overview</a></li>
    <li class="navBarCell1Rev">Package</li>
    <li>Class</li>
    <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    <li><a href="../../../index-all.html">Index</a></li>
    <li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>

<div class="subNav">
    <ul class="navList">
        <li><a href="../../../index.html?org/gradle/api/package-summary.html" target="_top">Frames</a></li>
        <li><a href="package-summary.html" target="_top">No Frames</a></li>
    </ul>
</div>

<!-- ========= END OF TOP NAVBAR ========= -->

<div class="header">
    <h1 class="title">Package org.gradle.api</h1>
</div>

<div class="header">
    <h2 title=" <p><b>Start Here:</b> Gradle's org.gradle.api.Project API, which is available from your build files. The
 API used from your build files is made up of 2 main interfaces:</p>

 <ul>
 <li>org.gradle.api.Project</li>
 <li>org.gradle.api.Task</li>
 </ul>
 
" class="title"> <p><b>Start Here:</b> Gradle's org.gradle.api.Project API, which is available from your build files. The
 API used from your build files is made up of 2 main interfaces:</p>

 <ul>
 <li>org.gradle.api.Project</li>
 <li>org.gradle.api.Task</li>
 </ul>
 
</h2>
</div>

<div class="contentContainer">


    <div class="summary">
        <ul class="blockList">
            <li class="blockList">
                <table border="0" cellpadding="3" cellspacing="0" summary="Interface Summary">
                    <caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
                    <tbody>
                    <tr>
                        <th class="colFirst" scope="col">Interface</th>
                        <th class="colLast" scope="col">Description</th>
                    </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Action.html" title="class in org/gradle/api">
                                    Action
                                </a></strong>
                            </td>
                            <td>Performs some action against objects of type T.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Buildable.html" title="class in org/gradle/api">
                                    Buildable
                                </a></strong>
                            </td>
                            <td>A <CODE>Buildable</CODE> represents an artifact or set of artifacts which are built by one or more Task
 instances.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="DomainObjectCollection.html" title="class in org/gradle/api">
                                    DomainObjectCollection
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="DomainObjectSet.html" title="class in org/gradle/api">
                                    DomainObjectSet
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="ExtensiblePolymorphicDomainObjectContainer.html" title="class in org/gradle/api">
                                    ExtensiblePolymorphicDomainObjectContainer
                                </a></strong>
                            </td>
                            <td>A <a href='../../../org/gradle/api/PolymorphicDomainObjectContainer.html' title='PolymorphicDomainObjectContainer'>PolymorphicDomainObjectContainer</a> that can be extended at runtime to
 create elements of new types.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Named.html" title="class in org/gradle/api">
                                    Named
                                </a></strong>
                            </td>
                            <td>Types can implement this interface and use the embedded Namer implementation, to satisfy API that calls for a namer.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="NamedDomainObjectCollection.html" title="class in org/gradle/api">
                                    NamedDomainObjectCollection
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="NamedDomainObjectContainer.html" title="class in org/gradle/api">
                                    NamedDomainObjectContainer
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="NamedDomainObjectFactory.html" title="class in org/gradle/api">
                                    NamedDomainObjectFactory
                                </a></strong>
                            </td>
                            <td>A factory for named objects of type <CODE>T</CODE>.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="NamedDomainObjectList.html" title="class in org/gradle/api">
                                    NamedDomainObjectList
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="NamedDomainObjectSet.html" title="class in org/gradle/api">
                                    NamedDomainObjectSet
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Namer.html" title="class in org/gradle/api">
                                    Namer
                                </a></strong>
                            </td>
                            <td>A namer is capable of providing a name based on some inherent characteristic of an object.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Plugin.html" title="class in org/gradle/api">
                                    Plugin
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="PolymorphicDomainObjectContainer.html" title="class in org/gradle/api">
                                    PolymorphicDomainObjectContainer
                                </a></strong>
                            </td>
                            <td>A NamedDomainObjectContainer that allows to create domain objects with different types.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Project.html" title="class in org/gradle/api">
                                    Project
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="ProjectEvaluationListener.html" title="class in org/gradle/api">
                                    ProjectEvaluationListener
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="ProjectState.html" title="class in org/gradle/api">
                                    ProjectState
                                </a></strong>
                            </td>
                            <td><CODE>ProjectState</CODE> provides information about the execution state of a project.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Rule.html" title="class in org/gradle/api">
                                    Rule
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Script.html" title="class in org/gradle/api">
                                    Script
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Task.html" title="class in org/gradle/api">
                                    Task
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Transformer.html" title="class in org/gradle/api">
                                    Transformer
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="XmlProvider.html" title="class in org/gradle/api">
                                    XmlProvider
                                </a></strong>
                            </td>
                            <td>Provides various ways to access the content of an XML document.</td>
                        </tr>

                    </tbody>
                </table>
            </li>
            </ul>
        </div>
    



    <div class="summary">
        <ul class="blockList">
            <li class="blockList">
                <table border="0" cellpadding="3" cellspacing="0" summary="Class Summary">
                    <caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
                    <tbody>
                    <tr>
                        <th class="colFirst" scope="col">Class</th>
                        <th class="colLast" scope="col">Description</th>
                    </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="AntBuilder.html" title="class in org/gradle/api">
                                    AntBuilder
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="DefaultTask.html" title="class in org/gradle/api">
                                    DefaultTask
                                </a></strong>
                            </td>
                            <td><CODE>DefaultTask</CODE> is the standard Task implementation. </td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Named.Namer.html" title="class in org/gradle/api">
                                    Named.Namer
                                </a></strong>
                            </td>
                            <td>An implementation of the namer interface for objects implementing the named interface.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Namer.Comparator.html" title="class in org/gradle/api">
                                    Namer.Comparator
                                </a></strong>
                            </td>
                            <td>A comparator implementation based on the names returned by the given namer.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Task.Namer.html" title="class in org/gradle/api">
                                    Task.Namer
                                </a></strong>
                            </td>
                            <td>A <a href='../../../org/gradle/api/Namer.html' title='Namer'>Namer</a> namer for tasks that returns <a href='#getName()'>getName()</a>.</td>
                        </tr>

                    </tbody>
                </table>
            </li>
            </ul>
        </div>
    


    <div class="summary">
        <ul class="blockList">
            <li class="blockList">
                <table border="0" cellpadding="3" cellspacing="0" summary="Enum Summary">
                    <caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
                    <tbody>
                    <tr>
                        <th class="colFirst" scope="col">Enum</th>
                        <th class="colLast" scope="col">Description</th>
                    </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="JavaVersion.html" title="class in org/gradle/api">
                                    JavaVersion
                                </a></strong>
                            </td>
                            <td>An enumeration of Java versions.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="PathValidation.html" title="class in org/gradle/api">
                                    PathValidation
                                </a></strong>
                            </td>
                            <td>An enumeration for describing validation policies for file paths.</td>
                        </tr>

                    </tbody>
                </table>
            </li>
            </ul>
        </div>
    


    <div class="summary">
        <ul class="blockList">
            <li class="blockList">
                <table border="0" cellpadding="3" cellspacing="0" summary="Exception Summary">
                    <caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
                    <tbody>
                    <tr>
                        <th class="colFirst" scope="col">Exception</th>
                        <th class="colLast" scope="col">Description</th>
                    </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="CircularReferenceException.html" title="class in org/gradle/api">
                                    CircularReferenceException
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="GradleException.html" title="class in org/gradle/api">
                                    GradleException
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="GradleScriptException.html" title="class in org/gradle/api">
                                    GradleScriptException
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="IllegalDependencyNotation.html" title="class in org/gradle/api">
                                    IllegalDependencyNotation
                                </a></strong>
                            </td>
                            <td>This exceptions is thrown, if a dependency is declared with a illegal notation.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="InvalidActionClosureException.html" title="class in org/gradle/api">
                                    InvalidActionClosureException
                                </a></strong>
                            </td>
                            <td>Thrown when a <a href='http://groovy.codehaus.org/gapi/groovy/lang/Closure.html' title='Closure'>Closure</a> is given as an Action implementation, but has the wrong signature.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="InvalidUserCodeException.html" title="class in org/gradle/api">
                                    InvalidUserCodeException
                                </a></strong>
                            </td>
                            <td>A <code>InvalidUserCodeException</code> is thrown when user-provided code cannot be executed.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="InvalidUserDataException.html" title="class in org/gradle/api">
                                    InvalidUserDataException
                                </a></strong>
                            </td>
                            <td>A <code>InvalidUserDataException</code> is thrown, if a user is providing illegal data for the build.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="ProjectConfigurationException.html" title="class in org/gradle/api">
                                    ProjectConfigurationException
                                </a></strong>
                            </td>
                            <td>Indicates a problem that occurs during project configuration (evaluation) phase.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="UncheckedIOException.html" title="class in org/gradle/api">
                                    UncheckedIOException
                                </a></strong>
                            </td>
                            <td><code>UncheckedIOException</code> is used to wrap an <a href='http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html' title='IOException'>IOException</a> into an unchecked exception.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="UnknownDomainObjectException.html" title="class in org/gradle/api">
                                    UnknownDomainObjectException
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="UnknownProjectException.html" title="class in org/gradle/api">
                                    UnknownProjectException
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="UnknownTaskException.html" title="class in org/gradle/api">
                                    UnknownTaskException
                                </a></strong>
                            </td>
                            <td></td>
                        </tr>

                    </tbody>
                </table>
            </li>
            </ul>
        </div>
    



    <div class="summary">
        <ul class="blockList">
            <li class="blockList">
                <table border="0" cellpadding="3" cellspacing="0" summary="Annotation Type Summary">
                    <caption><span>Annotation Type Summary</span><span class="tabEnd">&nbsp;</span></caption>
                    <tbody>
                    <tr>
                        <th class="colFirst" scope="col">Annotation Type</th>
                        <th class="colLast" scope="col">Description</th>
                    </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Incubating.html" title="class in org/gradle/api">
                                    Incubating
                                </a></strong>
                            </td>
                            <td>Indicates that a feature is incubating. </td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="NonExtensible.html" title="class in org/gradle/api">
                                    NonExtensible
                                </a></strong>
                            </td>
                            <td>Indicates that the type, when DSL enhanced, does not support extensibility.</td>
                        </tr>
<tr class="altColor">
                            <td class="colOne">
                                <strong><a href="Nullable.html" title="class in org/gradle/api">
                                    Nullable
                                </a></strong>
                            </td>
                            <td>Indicates that the value of an element can be null.</td>
                        </tr>

                    </tbody>
                </table>
            </li>
            </ul>
        </div>
    


</div>

<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="overview-summary.html">Overview</a></li>
        <li class="navBarCell1Rev">Package</li>
        <li>Class</li>
        <li><a href="deprecated-list.html">Deprecated</a></li>
        <li><a href="index-all.html">Index</a></li>
        <li><a href="help-doc.html">Help</a></li>
    </ul>
</div>
<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
            <li><a href="deprecated-list.html" target="_top">No Frames</a></li>
        </ul>
    </div>

    <div class="aboutLanguage"><em>Gradle API 2.0</em></div>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

</body>
</html>
